後払い API一覧
HTTP仕様(.idPass)
HTTP仕様(.json)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
EntryTranPostpay 取引登録
これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
Amount | amount | 必須 半角数字6桁
利用金額 税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
||
Tax | tax | 半角数字6桁
税送料 税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
/payment/EntryTranPostpay.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"orderID": "ORDER0000001",
"amount": "1000"
}
/payment/EntryTranPostpay.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000
レスポンス
{
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
ExecTranPostpay 決済実行
与信審査を実行し、審査結果を返却します。
リクエスト
ShopID | 必須 半角英数13桁
ショップID |
|
---|---|---|
ShopPass | 必須 半角英数64桁
ショップパスワード |
|
AccessID | 必須 半角英数32桁 固定
取引ID |
|
AccessPass | 必須 半角英数32桁 固定
取引パスワード |
|
OrderID | 必須 半角英数記号27桁
オーダーID |
|
HttpHeaderAccept | 全半角10000桁
Acceptヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderAcceptCharset | 全半角10000桁
Accept-Charsetヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderAcceptEncoding | 全半角10000桁
Accept-Encodingヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderAcceptLanguage | 全半角10000桁
Accept-Languageヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderClientIp | 全半角10000桁
Client-IPヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderConnection | 全半角10000桁
Connectionヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderDoNotTrack | 全半角10000桁
X-Do-Not-Trackヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderHost | 全半角10000桁
Hostヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderReferrer | 全半角10000桁
Referrerヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderUserAgent | 全半角10000桁
User-Agentヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderKeepAlive | 全半角10000桁
Keep-Aliveヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderUaCpu | 全半角10000桁
UA-CPUヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderVia | 全半角10000桁
Viaヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderXForwardedFor | 全半角10000桁
X-Forwarded-Forヘッダの値(※1)をご確認いただき、設定してください。 |
|
HttpHeaderOther | 全半角10000桁
その他のHTTPヘッダ(※1)をご確認いただき、設定してください。 |
|
CustomerIp | 全半角10000桁
購入者IPアドレス(※1)をご確認いただき、設定してください。 |
|
IMEI | 全半角10000桁
端末識別ID(※1)をご確認いただき、設定してください。 |
|
DeviceInfo | 全半角10000桁
デバイス情報(※2)をご確認頂き、設定してください。 |
|
CustomerOrderDate | 必須 半角数字8桁 固定
購入者情報_加盟店注文日 加盟店様サイトでの注文日を設定します。 |
|
CustomerName | 必須 全半角21桁
購入者情報_氏名(漢字)半角文字は全角文字に変換されます。 |
|
CustomerNameKana | 全半角25桁
購入者情報_氏名(カナ)半角文字は全角文字に変換されます。 |
|
CustomerZipCode | 必須 半角数字7桁
購入者情報_郵便番号 半角数字で設定してください。 |
|
CustomerAddress | 必須 全半角55桁
購入者情報_住所半角文字は全角文字に変換されます。 |
|
CustomerCompanyName | 全半角30桁
購入者情報_会社名 加盟店コードが「bb」から始まる場合は必須となります。 |
|
CustomerDepartmentName | 全半角30桁
購入者情報_部署名
|
|
CustomerTel1 | 必須 半角数字15桁
購入者情報_電話番号1 半角数字で設定してください。 |
|
CustomerTel2 | 半角数字15桁
購入者情報_電話番号2 半角数字で設定してください。 |
|
CustomerEmail1 | 必須 半角英数記号100桁
購入者情報_メールアドレス1 半角英数記号で設定してください。 |
|
CustomerEmail2 | 半角英数記号100桁
購入者情報_メールアドレス2 半角英数記号で設定してください。 |
|
CustomerPaymentType | 必須 半角数字1桁
購入者情報_決済種別 以下のいずれかコード値を設定します。 |
|
CustomerSex | 半角数字1桁
購入者情報_性別 以下のいずれかコード値を設定します。 |
|
CustomerBirthday | 半角数字8桁 固定
購入者情報_誕生日 半角数字で設定してください。 |
|
CustomerRegistDate | 半角数字8桁 固定
購入者情報_会員登録日 加盟店様サイトでのお客様の会員登録日を設定します。 |
|
CustomerBuyCount | 半角数字5桁
購入者情報_購入回数 加盟店様サイトでのお客様の購入回数を設定します。 |
|
CustomerBuyAmountTotal | 半角数字20桁
購入者情報_購入金額総額 加盟店様サイトでのお客様の購入金額合計を設定します。 |
|
CustomerID | 半角英数記号200桁
購入者情報_会員ID 加盟店様サイトでのお客様の会員IDを設定します。 |
|
DeliveryName | 全半角21桁
配送先項目_氏名(漢字) 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DeliveryNameKana | 全半角25桁
配送先項目_氏名(カナ) 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DeliveryZipCode | 半角数字7桁
配送先項目_郵便番号 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DeliveryAddress | 全半角55桁
配送先項目_住所 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DeliveryCompanyName | 全半角30桁
配送先項目_会社名 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DeliveryDepartmentName | 全半角30桁
配送先項目_部署名 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DeliveryTel | 半角数字15桁
配送先項目_電話番号 購入者情報と配送先情報が異なる場合に設定してください。 |
|
DetailName | 全半角300桁
明細項目_明細名 単一明細の場合に設定してください。 (※3) |
|
DetailPrice | 半角数字6桁
明細項目_単価 単一明細の場合に設定してください。(※3) |
|
DetailQuantity | 半角数字5桁
明細項目_数量 単一明細の場合に設定してください。 (※3) |
|
DetailBrand | 全半角300桁
明細項目_ブランド 単一明細の場合に設定してください。 (※3) |
|
DetailCategory | 全半角300桁
明細項目_カテゴリ 単一明細の場合に設定してください。 (※3) |
|
MultiItem |
明細情報一覧複数明細の場合に設定してください。 (※4) |
|
ClientField1 | 全半角100バイト
加盟店自由項目1
|
|
ClientField2 | 全半角100バイト
加盟店自由項目2
|
|
ClientField3 | 全半角100バイト
加盟店自由項目3
|
※1:取得できない項目は未設定としてください。
HttpHeaderAccept~IMEIの合計が9,968バイト以下となるように設定してください。
HttpHeaderDoNotTrackは、ブラウザがMozilla系の場合、DNTヘッダの値を設定してください。
HttpHeaderOther(その他のHTTPヘッダ)は、
HttpHeaderAccept~HttpHeaderXForwardedFor以外のヘッダ名と値をハイフン2つ(--)で結合し、
それらを全てコロン2つ(::)で接続した値を設定してください。
※2:デバイス情報を取得するため、
決済実行を行うページに下記HTMLコード(<script>タグ)の実装をお願いします。
id='fraudbuster'(<input type="hidden">を想定)にセットされる文字列を、
デバイス情報に設定してください。実装できない場合は未設定で構いません。
<input type="hidden" id="fraudbuster" name="fraudbuster" />
<script type="text/javascript" src="//cdn.credit.gmo-ab.com/psdatacollector.js"></script>
※3:単一明細のみ表示する場合、設定します。
複数明細を表示する場合、 明細情報一覧は設定しないでください。
明細情報一覧を設定した場合、本パラメータは無視されます。
※4:複数明細を表示する場合、設定します。
以下のXMLフォーマットを整形(タブや改行の除去)し、
UTF-8でBase64エンコードした値を設定してください。
/payment/ExecTranPostpay.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&HttpHeaderAccept=test1&HttpHeaderAcceptCharset=test2&HttpHeaderAcceptEncoding=test3&HttpHeaderAcceptLanguage=test4&HttpHeaderClientIp=test5&HttpHeaderConnection=test6&HttpHeaderDoNotTrack=test7&HttpHeaderHost=test8&HttpHeaderReferrer=test9&HttpHeaderUserAgent=test10&HttpHeaderKeepAlive=test11&HttpHeaderUaCpu=test12&HttpHeaderVia=test13&HttpHeaderXForwardedFor=test14&HttpHeaderOther=test15&CustomerIp=test16&IMEI=test17&DeviceInfo=test18&CustomerOrderDate=20201224&CustomerName=決済太郎&CustomerNameKana=ケッサイタロウ&CustomerZipCode=1000000&CustomerAddress=東京都&CustomerCompanyName=会社名&CustomerDepartmentName=部署名&CustomerTel1=09011111111&CustomerTel2=09011112222&CustomerEmail1=sample1@test.com&CustomerEmail2=sample2@test.com&CustomerPaymentType=2&CustomerSex=1&CustomerBirthday=20201225&CustomerRegistDate=20201226&CustomerBuyCount=10&CustomerBuyAmountTotal=2000&CustomerID=testid&DeliveryName=配達先&DeliveryNameKana=ハイタツサキ&DeliveryZipCode=1234567&DeliveryAddress=神奈川県&DeliveryCompanyName=配達先会社名&DeliveryDepartmentName=ハイタツサキカイシャメイ&DeliveryTel=09011113333&DetailName=商品名&DetailPrice=500&DetailQuantity=1&DetailBrand=後払いアウトレット&DetailCategory=服飾品&ClientField1=Free1&ClientField2=Free2&ClientField3=Free3
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&HttpHeaderAccept=test1&HttpHeaderAcceptCharset=test2&HttpHeaderAcceptEncoding=test3&HttpHeaderAcceptLanguage=test4&HttpHeaderClientIp=test5&HttpHeaderConnection=test6&HttpHeaderDoNotTrack=test7&HttpHeaderHost=test8&HttpHeaderReferrer=test9&HttpHeaderUserAgent=test10&HttpHeaderKeepAlive=test11&HttpHeaderUaCpu=test12&HttpHeaderVia=test13&HttpHeaderXForwardedFor=test14&HttpHeaderOther=test15&CustomerIp=test16&IMEI=test17&DeviceInfo=test18&CustomerOrderDate=20201224&CustomerName=決済太郎&CustomerNameKana=ケッサイタロウ&CustomerZipCode=1000000&CustomerAddress=東京都&CustomerCompanyName=会社名&CustomerDepartmentName=部署名&CustomerTel1=09011111111&CustomerTel2=09011112222&CustomerEmail1=sample1@test.com&CustomerEmail2=sample2@test.com&CustomerPaymentType=2&CustomerSex=1&CustomerBirthday=20201225&CustomerRegistDate=20201226&CustomerBuyCount=10&CustomerBuyAmountTotal=2000&CustomerID=testid&DeliveryName=配達先&DeliveryNameKana=ハイタツサキ&DeliveryZipCode=1234567&DeliveryAddress=神奈川県&DeliveryCompanyName=配達先会社名&DeliveryDepartmentName=ハイタツサキカイシャメイ&DeliveryTel=09011113333&MultiItem=PGRldGFpbHNJbmZvPiA8ZGV0YWlsPiA8bmFtZT5U44K344Oj44OEPC9uYW1lPiA8cHJpY2U+MTIwMDwvcHJpY2U+IDxxdWFudGl0eT4zPC9xdWFudGl0eT4gPGJyYW5kPuODhuOCueODiOODluODqeODs+ODiTwvYnJhbmQ+IDxjYXRlZ29yeT7jg6Hjg7Pjgrrjg5XjgqHjg4Pjgrfjg6fjg7M8L2NhdGVnb3J5PiA8L2RldGFpbD4gPGRldGFpbD4gPG5hbWU+44K444Oj44Kx44OD44OIPC9uYW1lPiA8cHJpY2U+MjUwMDA8L3ByaWNlPiA8cXVhbnRpdHk+MTwvcXVhbnRpdHk+IDwvZGV0YWlsPiA8L2RldGFpbHNJbmZvPg==&ClientField1=Free1&ClientField2=Free2&ClientField3=Free3
[XMLフォーマット]
detailsInfo |
明細情報一覧 |
||
---|---|---|---|
detail |
最大15件まで指定できます。 |
||
name | 必須 全半角300桁
明細名 |
||
price | 必須 半角数字6桁
単価半角数字で税込みの単価を設定してください。 |
||
quantity | 必須 半角数字5桁
数量半角数字(マイナス許可)で設定してください。 |
||
brand | 全半角300桁
ブランド |
||
category | 全半角300桁
カテゴリ |
XMLヘッダは不要です。
[XMLサンプル]
<detailsInfo>
<detail>
<name>Tシャツ</name>
<price>1200</price>
<quantity>3</quantity>
<brand>テストブランド</brand>
<category>メンズファッション</category>
</detail>
<detail>
<name>ジャケット</name>
<price>25000</price>
<quantity>1</quantity>
</detail>
</detailsInfo>
リクエスト
shopID |
必須
半角英数13桁
ショップID |
|
---|---|---|
shopPass |
必須
半角英数64桁
ショップパスワード |
|
accessID |
必須
半角英数32桁 固定
取引ID |
|
accessPass |
必須
半角英数32桁 固定
取引パスワード |
|
orderID |
必須
半角英数記号27桁
オーダーID |
|
httpHeaderAccept |
全半角10000桁
Acceptヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderAcceptCharset |
全半角10000桁
Accept-Charsetヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderAcceptEncoding |
全半角10000桁
Accept-Encodingヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderAcceptLanguage |
全半角10000桁
Accept-Languageヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderClientIp |
全半角10000桁
Client-IPヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderConnection |
全半角10000桁
Connectionヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderDoNotTrack |
全半角10000桁
X-Do-Not-Trackヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderHost |
全半角10000桁
Hostヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderReferrer |
全半角10000桁
Referrerヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderUserAgent |
全半角10000桁
User-Agentヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderKeepAlive |
全半角10000桁
Keep-Aliveヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderUaCpu |
全半角10000桁
UA-CPUヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderVia |
全半角10000桁
Viaヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderXForwardedFor |
全半角10000桁
X-Forwarded-Forヘッダの値(※1)をご確認いただき、設定してください。 |
|
httpHeaderOther |
全半角10000桁
その他のHTTPヘッダ(※1)をご確認いただき、設定してください。 |
|
customerIp |
全半角10000桁
購入者IPアドレス(※1)をご確認いただき、設定してください。 |
|
iMEI |
全半角10000桁
端末識別ID(※1)をご確認いただき、設定してください。 |
|
deviceInfo | 全半角10000桁
デバイス情報(※2)をご確認頂き、設定してください。 |
|
customerOrderDate | 必須 半角数字8桁 固定
購入者情報_加盟店注文日加盟店様サイトでの注文日を設定します。 |
|
customerName | 必須 全半角21桁
購入者情報_氏名(漢字)半角文字は全角文字に変換されます。 |
|
customerNameKana | 全半角25桁
購入者情報_氏名(カナ)半角文字は全角文字に変換されます。 |
|
customerZipCode | 必須 半角数字7桁
購入者情報_郵便番号半角数字で設定してください。 |
|
customerAddress | 必須 全半角55桁
購入者情報_住所半角文字は全角文字に変換されます。 |
|
customerCompanyName | 全半角30桁
購入者情報_会社名加盟店コードが「bb」から始まる場合に設定してください。 |
|
customerDepartmentName | 全半角30桁
購入者情報_部署名 |
|
customerTel1 | 必須 半角数字15桁
購入者情報_電話番号1半角数字で設定してください。 |
|
customerTel2 | 半角数字15桁
購入者情報_電話番号2半角数字で設定してください。 |
|
customerEmail1 | 必須 半角英数記号100桁
購入者情報_メールアドレス1半角英数記号で設定してください。 |
|
customerEmail2 | 半角英数記号100桁
購入者情報_メールアドレス2半角英数記号で設定してください。 |
|
customerPaymentType | 必須 半角数字1桁
購入者情報_決済種別以下のいずれかコード値を設定します。 |
|
customerSex | 半角数字1桁
購入者情報_性別以下のいずれかコード値を設定します。 |
|
customerBirthday | 半角数字8桁 固定
購入者情報_誕生日半角数字で設定してください。 |
|
customerRegistDate | 半角数字8桁 固定
購入者情報_会員登録日加盟店様サイトでのお客様の会員登録日を設定します。 |
|
customerBuyCount | 半角数字5桁
購入者情報_購入回数加盟店様サイトでのお客様の購入回数を設定します。 |
|
customerBuyAmountTotal |
半角数字20桁
購入者情報_購入金額総額加盟店様サイトでのお客様の購入金額合計を設定します。 |
|
customerID |
半角英数記号200桁
購入者情報_会員ID加盟店様サイトでのお客様の会員IDを設定します。 |
|
deliveryName | 全半角21桁
配送先項目_氏名(漢字)購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryNameKana | 全半角25桁
配送先項目_氏名(カナ)購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryZipCode | 半角数字7桁
配送先項目_郵便番号購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryAddress | 全半角55桁
配送先項目_住所購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryCompanyName | 全半角30桁
配送先項目_会社名購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryDepartmentName | 全半角30桁
配送先項目_部署名購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryTel | 半角数字15桁
配送先項目_電話番号購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
details | 必須
明細一覧最大15件まで指定できます。 |
|
name | 必須 全半角300桁
明細項目_明細名【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
price | 必須 半角数字6桁
明細項目_単価【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
quantity | 必須 半角数字5桁
明細項目_数量【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
brand | 全半角300桁
明細項目_ブランド【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
category | 必須 全半角300桁
明細項目_カテゴリ【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
clientField1 | 全半角100バイト
加盟店自由項目1 |
|
clientField2 | 全半角100バイト
加盟店自由項目2 |
|
clientField3 | 全半角100バイト
加盟店自由項目3 |
※1:取得できない項目は未設定としてください。
HttpHeaderAccept~IMEIの合計が9,968バイト以下となるように設定してください。
HttpHeaderDoNotTrackは、ブラウザがMozilla系の場合、DNTヘッダの値を設定してください。
HttpHeaderOther(その他のHTTPヘッダ)は、
HttpHeaderAccept~HttpHeaderXForwardedFor以外のヘッダ名と値をハイフン2つ(--)で結合し、
それらを全てコロン2つ(::)で接続した値を設定してください。
※2:デバイス情報を取得するため、
決済実行を行うページに下記HTMLコード(<script>タグ)の実装をお願いします。
id='fraudbuster'(<input type="hidden">を想定)にセットされる文字列を、
デバイス情報に設定してください。実装できない場合は未設定で構いません。
<input type="hidden" id="fraudbuster" name="fraudbuster" />
<script type="text/javascript" src="//fraud-buster.appspot.com/js/fraudbuster.js"></script>
/payment/ExecTranPostpay.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"accessID":"a6a6b0061347e90cdef806b39bd28705",
"accessPass":"5e0e54b892e14ed03e8cf807a6053813",
"orderID":"ORDER0000001",
"httpHeaderAccept":"test1",
"httpHeaderAcceptCharset":"test2",
"httpHeaderAcceptEncoding":"test3",
"httpHeaderAcceptLanguage":"test4",
"httpHeaderClientIp":"test5",
"httpHeaderConnection":"test6",
"httpHeaderDoNotTrack":"test7",
"httpHeaderHost":"test8",
"httpHeaderReferrer":"test9",
"httpHeaderUserAgent":"test10",
"httpHeaderKeepAlive":"test11",
"httpHeaderUaCpu":"test12",
"httpHeaderVia":"test13",
"httpHeaderXForwardedFor":"test14",
"httpHeaderOther":"test15",
"customerIp":"test16",
"imei":"test17",
"deviceInfo":"test18",
"customerOrderDate":"20201224",
"customerName":"決済太郎",
"customerNameKana":"ケッサイタロウ",
"customerZipCode":"1000000",
"customerAddress":"東京都",
"customerCompanyName":"会社名",
"customerDepartmentName":"部署名",
"customerTel1":"09011111111",
"customerTel2":"09011112222",
"customerEmail1":"sample1@test.com",
"customerEmail2":"sample2@test.com",
"customerPaymentType":"2",
"customerSex":"1",
"customerBirthday":"20201225",
"customerRegistDate":"20201226",
"customerBuyCount":"10",
"customerBuyAmountTotal":"2000",
"customerID":"testid",
"deliveryName":"配達先",
"deliveryNameKana":"ハイタツサキ",
"deliveryZipCode":"1234567",
"deliveryAddress":"神奈川県",
"deliveryCompanyName":"配達先会社名",
"deliveryDepartmentName":"ハイタツサキカイシャメイ",
"deliveryTel":"09011113333",
"details":[
{
"name":"Tシャツ",
"price":"2000",
"quantity":"1",
"brand":"サンプルブランド"
}
],
"clientField1":"自由項目1",
"clientField2":"自由項目2",
"clientField3":"自由項目3"
}
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status | 半角英字11桁
現状態 対象取引の取引状態を返却します。 |
||
TranDate | tranDate | 半角数字14桁 固定
処理日時 当サービスで処理を実施した日時を返却します。 |
||
PostpayTransactionId | postpayTransactionId | 半角英数11桁
後払い取引ID後払い側の取引IDを返却します。 |
||
CheckString | checkString | 半角英数64桁
改ざんチェック文字列OrderID、AccessID、ShopID、ShopPass、PostpayTransactionIdを連結し、SHA256ハッシュした値を返却します。 |
{
"orderID": "ORDER0000001",
"status": "AUTH",
"tranDate": "20201225091313",
"postpayTransactionId": "11111111111",
"checkString": "a169d60dff0956a99f709436b21a74ed1c1d6cadf52db80b719b7bb5f50bc697"
}
OrderID=ORDER0000001&Status=AUTH&TranDate=20201225091313&PostpayTransactionId=11111111111&CheckString=a169d60dff0956a99f709436b21a74ed1c1d6cadf52db80b719b7bb5f50bc697
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayInvoiceData 請求書印字データ取得
請求書印刷時に利用するデータを取得します。 請求書同梱サービスをご利用の場合、実行してください。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
/payment/PostpayInvoiceData.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001"
}
/payment/PostpayInvoiceData.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status |
現状態 対象取引の取引状態を返却します。 |
||
InvoiceData | invoiceData |
請求書データ UTF-8でBase64エンコードした値を返却します。 |
{
"orderID": "ORDER0000001",
"status": "INVOICE",
"invoiceData": "PGludm9pY2VEYXRhUmVzdWx0PjxnbW9U~(以下省略)"
}
OrderID=ORDER0000001&Status=INVOICE&InvoiceData=PGludm9pY2VEYXRhUmVzdWx0PjxnbW9U~(以下省略)
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayShipping 出荷報告
お客様への商品発送後に出荷報告を行います。
出荷報告が行われない場合、立替払いの対象外となります。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
PdCompanyCode | pdCompanyCode | 必須 半角数字2桁
運送会社コード 荷物を発送した運送会社を以下のコードから設定します。 |
||
SlipNo | slipNo | 必須 半角数字20桁
発送伝票番号運送会社の伝票番号を設定します。 |
/payment/PostpayShipping.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001",
"pdCompanyCode": "12",
"slipNo": "123456789"
}
/payment/PostpayShipping.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PdCompanyCode=12&SlipNo=123456789
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status |
現状態 対象取引の取引状態を返却します。 |
{
"orderID": "ORDER0000001",
"status": "SHIPPED"
}
OrderID=ORDER0000001&Status=SHIPPED
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayChange 決済変更
決済内容の変更を行います。 変更内容により、与信審査が再度実行され、審査結果を返却します。
リクエスト
ShopID | 必須 半角英数13桁
ショップID
|
|
---|---|---|
ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
AccessID | 必須 半角英数32桁 固定
取引ID
|
|
AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
OrderID | 必須 半角英数記号27桁
オーダーID
|
|
Amount | 必須 半角数字6桁
利用金額 税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|
Tax | 半角数字6桁
税送料 税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|
CustomerOrderDate | 必須 半角数字8桁 固定
購入者情報_加盟店注文日 加盟店様サイトでの注文日を設定します。 |
|
CustomerName | 必須 全半角21桁
購入者情報_氏名(漢字)半角文字は全角文字に変換されます。 |
|
CustomerNameKana | 全半角25桁
購入者情報_氏名(カナ)半角文字は全角文字に変換されます。 |
|
CustomerZipCode | 必須 半角数字7桁
購入者情報_郵便番号 半角数字で設定してください。 |
|
CustomerAddress | 必須 全半角55桁
購入者情報_住所半角文字は全角文字に変換されます。 |
|
CustomerCompanyName | 全半角30桁
購入者情報_会社名加盟店コードが「bb」から始まる場合に設定してください。 |
|
CustomerDepartmentName | 全半角30桁
購入者情報_部署名
|
|
CustomerTel1 | 必須 半角数字15桁
購入者情報_電話番号1 半角数字で設定してください。 |
|
CustomerTel2 | 半角数字15桁
購入者情報_電話番号2 半角数字で設定してください。 |
|
CustomerEmail1 | 必須 半角英数記号100桁
購入者情報_メールアドレス1 半角英数記号で設定してください。 |
|
CustomerEmail2 | 半角英数記号100桁
購入者情報_メールアドレス2 半角英数記号で設定してください。 |
|
CustomerPaymentType | 必須 半角数字1桁
購入者情報_決済種別 以下のいずれかコード値を設定します。 |
|
CustomerSex | 半角数字1桁
購入者情報_性別 以下のいずれかコード値を設定します。 |
|
CustomerBirthday | 半角数字8桁 固定
購入者情報_誕生日 半角数字で設定してください。 |
|
CustomerRegistDate | 半角数字8桁 固定
購入者情報_会員登録日 加盟店様サイトでのお客様の会員登録日を設定します。 |
|
CustomerBuyCount | 半角数字5桁
購入者情報_購入回数 加盟店様サイトでのお客様の購入回数を設定します。 |
|
CustomerBuyAmountTotal | 半角数字20桁
購入者情報_購入金額総額 加盟店様サイトでのお客様の購入金額合計を設定します。 |
|
CustomerID | 半角英数記号200桁
購入者情報_会員ID 加盟店様サイトでのお客様の会員IDを設定します。 |
|
DeliveryName | 全半角21桁
配送先項目_氏名(漢字)購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DeliveryNameKana | 全半角25桁
配送先項目_氏名(カナ)購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DeliveryZipCode | 半角数字7桁
配送先項目_郵便番号購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DeliveryAddress | 全半角55桁
配送先項目_住所購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DeliveryCompanyName | 全半角30桁
配送先項目_会社名購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DeliveryDepartmentName | 全半角30桁
配送先項目_部署名購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DeliveryTel | 半角数字15桁
配送先項目_電話番号購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
DetailName | 全半角300桁
明細項目_明細名 単一明細の場合に設定してください。 (※1) |
|
DetailPrice | 半角数字6桁
明細項目_単価 単一明細の場合に設定してください。(※1) |
|
DetailQuantity | 半角数字5桁
明細項目_数量 単一明細の場合に設定してください。 (※1) |
|
DetailBrand | 全半角300桁
明細項目_ブランド 単一明細の場合に設定してください。 (※1) |
|
DetailCategory | 全半角300桁
明細項目_カテゴリ 単一明細の場合に設定してください。 (※1) |
|
MultiItem |
明細情報一覧(※2)複数明細の場合に設定してください。 |
※1:単一明細のみ表示する場合、設定します。
複数明細を表示する場合、 明細情報一覧は設定しないでください。
明細情報一覧を設定した場合、本パラメータは無視されます。
※2:複数明細を表示する場合、設定します。
以下のXMLフォーマットを整形(タブや改行の除去)し、
UTF-8でBase64エンコードした値を設定してください。
/payment/PostpayChange.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=200&Tax=20&CustomerOrderDate=20201228&CustomerName=決済太郎&CustomerNameKana=ケッサイタロウ&CustomerZipCode=1000000&CustomerAddress=東京都&CustomerCompanyName=会社名&CustomerDepartmentName=部署名&CustomerTel1=09011111111&CustomerTel2=09011112222&CustomerEmail1=sample1@test.com&CustomerEmail2=sample2@test.com&CustomerPaymentType=2&CustomerSex=1&CustomerBirthday=20201225&CustomerRegistDate=20201226&CustomerBuyCount=10&CustomerBuyAmountTotal=2000&CustomerID=testid&DeliveryName=配達先&DeliveryNameKana=ハイタツサキ&DeliveryZipCode=1234567&DeliveryAddress=神奈川県&DeliveryCompanyName=配達先会社名&DeliveryDepartmentName=ハイタツサキカイシャメイ&DeliveryTel=09011113333&DetailName=商品名&DetailPrice=500&DetailQuantity=1&DetailBrand=後払いアウトレット&DetailCategory=服飾品
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=200&Tax=20&CustomerOrderDate=20201228&CustomerName=決済太郎&CustomerNameKana=ケッサイタロウ&CustomerZipCode=1000000&CustomerAddress=東京都&CustomerCompanyName=会社名&CustomerDepartmentName=部署名&CustomerTel1=09011111111&CustomerTel2=09011112222&CustomerEmail1=sample1@test.com&CustomerEmail2=sample2@test.com&CustomerPaymentType=2&CustomerSex=1&CustomerBirthday=20201225&CustomerRegistDate=20201226&CustomerBuyCount=10&CustomerBuyAmountTotal=2000&CustomerID=testid&DeliveryName=配達先&DeliveryNameKana=ハイタツサキ&DeliveryZipCode=1234567&DeliveryAddress=神奈川県&DeliveryCompanyName=配達先会社名&DeliveryDepartmentName=ハイタツサキカイシャメイ&DeliveryTel=09011113333&MultiItem=PGRldGFpbHNJbmZvPiA8ZGV0YWlsPiA8bmFtZT5U44K344Oj44OEPC9uYW1lPiA8cHJpY2U+MTIwMDwvcHJpY2U+IDxxdWFudGl0eT4zPC9xdWFudGl0eT4gPGJyYW5kPuODhuOCueODiOODluODqeODs+ODiTwvYnJhbmQ+IDxjYXRlZ29yeT7jg6Hjg7Pjgrrjg5XjgqHjg4Pjgrfjg6fjg7M8L2NhdGVnb3J5PiA8L2RldGFpbD4gPGRldGFpbD4gPG5hbWU+44K444Oj44Kx44OD44OIPC9uYW1lPiA8cHJpY2U+MjUwMDA8L3ByaWNlPiA8cXVhbnRpdHk+MTwvcXVhbnRpdHk+IDwvZGV0YWlsPiA8L2RldGFpbHNJbmZvPg==PGRldGFpbHNJbmZvPiA8ZGV0YWlsPiA8bmFtZT5U44K344Oj44OEPC9uYW1lPiA8cHJpY2U+MTIwMDwvcHJpY2U+IDxxdWFudGl0eT4zPC9xdWFudGl0eT4gPGJyYW5kPuODhuOCueODiOODluODqeODs+ODiTwvYnJhbmQ+IDxjYXRlZ29yeT7jg6Hjg7Pjgrrjg5XjgqHjg4Pjgrfjg6fjg7M8L2NhdGVnb3J5PiA8L2RldGFpbD4gPGRldGFpbD4gPG5hbWU+44K444Oj44Kx44OD44OIPC9uYW1lPiA8cHJpY2U+MjUwMDA8L3ByaWNlPiA8cXVhbnRpdHk+MTwvcXVhbnRpdHk+IDwvZGV0YWlsPiA8L2RldGFpbHNJbmZvPg==
[XMLフォーマット]
detailsInfo |
明細情報一覧 |
||
---|---|---|---|
detail |
最大15件まで指定できます。 |
||
name | 必須 全半角300桁
明細名 |
||
price | 必須 半角数字6桁
単価半角数字で税込みの単価を設定してください。 |
||
quantity | 必須 半角数字5桁
数量半角数字(マイナス許可)で設定してください。 |
||
brand | 全半角300桁
ブランド |
||
category | 全半角300桁
カテゴリ |
XMLヘッダは不要です。
[XMLサンプル]
<detailsInfo>
<detail>
<name>Tシャツ</name>
<price>1200</price>
<quantity>3</quantity>
<brand>テストブランド</brand>
<category>メンズファッション</category>
</detail>
<detail>
<name>ジャケット</name>
<price>25000</price>
<quantity>1</quantity>
</detail>
</detailsInfo>
リクエスト
shopID |
必須
半角英数13桁
ショップID |
|
---|---|---|
shopPass |
必須
半角英数64桁
ショップパスワード |
|
accessID |
必須
半角英数32桁 固定
取引ID【取引登録】で発行された値を設定します。 |
|
accessPass |
必須
半角英数32桁 固定
取引パスワード【取引登録】で発行された値を設定します。 |
|
orderID |
必須
半角英数記号27桁
オーダーID【取引登録】で指定した値を設定します。 |
|
amount |
半角数字6桁
利用金額税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|
tax |
半角数字6桁
税送料税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|
customerOrderDate | 必須 半角数字8桁 固定
購入者情報_加盟店注文日加盟店様サイトでの注文日を設定します。 |
|
customerName | 必須 全半角21桁
購入者情報_氏名(漢字)半角文字は全角文字に変換されます。 |
|
customerNameKana | 全半角25桁
購入者情報_氏名(カナ)半角文字は全角文字に変換されます。 |
|
customerZipCode | 必須 半角数字7桁
購入者情報_郵便番号半角数字で設定してください。 |
|
customerAddress | 必須 全半角55桁
購入者情報_住所半角文字は全角文字に変換されます。 |
|
customerCompanyName | 全半角30桁
購入者情報_会社名加盟店コードが「bb」から始まる場合に設定してください。 |
|
customerDepartmentName | 全半角30桁
購入者情報_部署名 |
|
customerTel1 | 必須 半角数字15桁
購入者情報_電話番号1半角数字で設定してください。 |
|
customerTel2 | 半角数字15桁
購入者情報_電話番号2半角数字で設定してください。 |
|
customerEmail1 | 必須 半角英数記号100桁
購入者情報_メールアドレス1半角英数記号で設定してください。 |
|
customerEmail2 | 半角英数記号100桁
購入者情報_メールアドレス2半角英数記号で設定してください。 |
|
customerPaymentType | 必須 半角数字1桁
購入者情報_決済種別以下のいずれかコード値を設定します。 |
|
customerSex | 半角数字1桁
購入者情報_性別以下のいずれかコード値を設定します。 |
|
customerBirthday | 半角数字8桁 固定
購入者情報_誕生日半角数字で設定してください。 |
|
customerRegistDate | 半角数字8桁 固定
購入者情報_会員登録日加盟店様サイトでのお客様の会員登録日を設定します。 |
|
customerBuyCount | 半角数字5桁
購入者情報_購入回数加盟店様サイトでのお客様の購入回数を設定します。 |
|
customerBuyAmountTotal |
半角数字20桁
購入者情報_購入金額総額加盟店様サイトでのお客様の購入金額合計を設定します。 |
|
customerID |
半角英数記号200桁
購入者情報_会員ID加盟店様サイトでのお客様の会員IDを設定します。 |
|
deliveryName | 全半角21桁
配送先項目_氏名(漢字)購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryNameKana | 全半角25桁
配送先項目_氏名(カナ)購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryZipCode | 半角数字7桁
配送先項目_郵便番号購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryAddress | 全半角55桁
配送先項目_住所購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryCompanyName | 全半角30桁
配送先項目_会社名購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryDepartmentName | 全半角30桁
配送先項目_部署名購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
deliveryTel | 半角数字15桁
配送先項目_電話番号購入者情報と配送先情報が異なる場合に設定してください。設定可能な文字列や仕様は購入者情報と同等です。 |
|
details | 必須
明細一覧最大15件まで指定できます。 |
|
name | 必須 全半角300桁
明細項目_明細名【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
price | 必須 半角数字6桁
明細項目_単価【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
quantity | 必須 半角数字5桁
明細項目_数量【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
brand | 全半角300桁
明細項目_ブランド【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
category | 必須 全半角300桁
明細項目_カテゴリ【明細項目_単価】半角数字で税込みの単価を設定してください。 |
/payment/PostpayChange.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"accessID":"a6a6b0061347e90cdef806b39bd28705",
"accessPass":"5e0e54b892e14ed03e8cf807a6053813",
"orderID":"ORDER0000001",
"amount":"200",
"tax":"20",
"customerOrderDate":"20201224",
"customerName":"決済太郎",
"customerNameKana":"ケッサイタロウ",
"customerZipCode":"1000000",
"customerAddress":"東京都",
"customerCompanyName":"会社名",
"customerDepartmentName":"部署名",
"customerTel1":"09011111111",
"customerTel2":"09011112222",
"customerEmail1":"sample1@test.com",
"customerEmail2":"sample2@test.com",
"customerPaymentType":"2",
"customerSex":"1",
"customerBirthday":"20201225",
"customerRegistDate":"20201226",
"customerBuyCount":"10",
"customerBuyAmountTotal":"2000",
"customerID":"testid",
"deliveryName":"配達先",
"deliveryNameKana":"ハイタツサキ",
"deliveryZipCode":"1234567",
"deliveryAddress":"神奈川県",
"deliveryCompanyName":"配達先会社名",
"deliveryDepartmentName":"ハイタツサキカイシャメイ",
"deliveryTel":"09011113333",
"details":[
{
"name":"Tシャツ",
"price":"2000",
"quantity":"1",
"brand":"サンプルブランド"
}
]
}
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status | 半角英字11桁
現状態 対象取引の取引状態を返却します。 |
||
TranDate | tranDate | 半角数字14桁 固定
処理日時 当サービスで処理を実施した日時を返却します。 |
||
PostpayTransactionId | postpayTransactionId | 半角英数11桁
後払い取引ID後払い側の取引IDを返却します。 |
||
CheckString | checkString | 半角英数64桁
改ざんチェック文字列OrderID、AccessID、ShopID、ShopPass、PostpayTransactionIdを連結し、SHA256ハッシュした値を返却します。 |
{
"orderID": "ORDER0000001",
"status": "AUTH",
"tranDate": "20201228092521",
"postpayTransactionId": "11111111111",
"checkString": "bc98e504d30ed3671b9ac4b50e710c63a79671c9a31fef75e2f6cb496cf2c15a"
}
orderID=ORDER0000001&status=AUTH&tranDate=20201228092521&postpayTransactionId=11111111111&checkString=bc98e504d30ed3671b9ac4b50e710c63a79671c9a31fef75e2f6cb496cf2c15a
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayCancel 決済取消
決済内容のキャンセル行います。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
/payment/PostpayCancel.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001"
}
/payment/PostpayCancel.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status |
現状態 対象取引の取引状態を返却します。 |
{
"orderID": "ORDER0000001",
"status": "CANCEL"
}
OrderID=ORDER0000001&Status=CANCEL
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayShippingChange 出荷変更
出荷報告内容の変更を行います。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
PdCompanyCode | pdCompanyCode | 必須 半角数字2桁
運送会社コード 荷物を発送した運送会社を以下のコードから設定します。 |
||
SlipNo | slipNo | 必須 半角数字20桁
発送伝票番号運送会社の伝票番号を設定します。 |
/payment/PostpayShippingChange.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001",
"pdCompanyCode": "14",
"slipNo": "1111111111"
}
/payment/PostpayShippingChange.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PdCompanyCode=14&SlipNo=1111111111
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status | 半角英字11桁
現状態 対象取引の取引状態を返却します。 |
{
"orderID": "ORDER0000001",
"status": "SHIPPED"
}
OrderID=ORDER0000001&Status=SHIPPED
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayShippingCancel 出荷取消
出荷報告内容の取消を行います。 出荷報告の翌日以降に実行した場合、エラーを返却します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
/payment/PostpayShippingCancel.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001"
}
/payment/PostpayShippingCancel.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status |
現状態 対象取引の取引状態を返却します。 |
{
"orderID": "ORDER0000001",
"status": "AUTH"
}
OrderID=ORDER0000001&Status=AUTH
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayReissueInvoice 請求書再発行申請
請求書の再発行を行います。
請求書再発行申請を行った場合、お客様にはGMO-PSより請求書を送付します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
DestinationType | destinationType | 必須 半角数字1桁
送付先区分 請求書送付先の変更有無を以下の区分で設定します。 |
||
ReasonCode | reasonCode | 必須 半角数字2桁
依頼理由コード 請求書再発行の理由を以下の区分で設定します。 |
||
OtherReason | otherReason | 全半角256桁
その他依頼理由
|
||
CustomerName | customerName | 全半角21桁
購入者情報_氏名(漢字)半角文字は全角文字に変換されます。※1 |
||
CustomerNameKana | customerNameKana | 全半角25桁
購入者情報_氏名(カナ)半角文字は全角文字に変換されます。※1 |
||
CustomerZipCode | customerZipCode | 半角数字7桁
購入者情報_郵便番号 半角数字で設定してください。 |
||
CustomerAddress | customerAddress | 全半角55桁
購入者情報_住所半角文字は全角文字に変換されます。※1 |
||
CustomerCompanyName | customerCompanyName | 全半角30桁
購入者情報_会社名加盟店コードが「bb」から始まる場合に設定してください。※1 |
||
CustomerDepartmentName | customerDepartmentName | 全半角30桁
購入者情報_部署名※1 |
||
CustomerTel1 | customerTel1 | 半角数字15桁
購入者情報_電話番号1 半角数字で設定してください。 |
||
CustomerTel2 | customerTel2 | 半角数字15桁
購入者情報_電話番号2 半角数字で設定してください。 |
||
CustomerEmail1 | customerEmail1 | 半角英数記号100桁
購入者情報_メールアドレス1 半角英数記号で設定してください。 |
||
CustomerEmail2 | customerEmail2 | 半角英数記号100桁
購入者情報_メールアドレス2 半角英数記号で設定してください。 |
※1 送付先区分が「2:新しい請求書送付先」かつ、変更がある場合に設定してください。
※2 例)購入者情報_メールアドレスの場合(購入者情報_電話番号も同様です)
決済実行時 | 請求書再発行申請時 | 設定される値 | |
---|---|---|---|
例1 | 購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 なし |
購入者情報_メールアドレス1 bnpl2@example.com 購入者情報_メールアドレス2 なし |
購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 bnpl2@example.com |
例2 | 購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 bnpl2@example.com |
購入者情報_メールアドレス1 bnpl3@example.com 購入者情報_メールアドレス2 bnpl4@example.com |
購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 bnpl2@example.com ※bnpl3,bnpl4は反映されません |
例3 | 購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 なし |
購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 bnpl2@example.com |
購入者情報_メールアドレス1 bnpl1@example.com 購入者情報_メールアドレス2 bnpl2@example.com ※bnpl1は既に設定されているためbnpl2のみ反映されます |
/payment/PostpayReissueInvoice.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"accessID":"a6a6b0061347e90cdef806b39bd28705",
"accessPass":"5e0e54b892e14ed03e8cf807a6053813",
"orderID":"ORDER0000001",
"destinationType":"2",
"reasonCode":"03",
"otherReason":"住所変更のため",
"customerName":"決済太郎",
"customerNameKana":"ケッサイタロウ",
"customerZipCode":"1000000",
"customerAddress":"東京都",
"customerCompanyName":"決済会社",
"customerDepartmentName":"決済部門",
"customerTel1":"09011111111",
"customerTel2":"09022222222",
"customerEmail1":"sample@test.com",
"customerEmail2":"sample@test.com"
}
/payment/PostpayReissueInvoice.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&DestinationType=2&ReasonCode=03&OtherReason=住所変更のため&CustomerName=決済太郎&CustomerNameKana=ケッサイタロウ&CustomerZipCode=1000000&CustomerAddress=東京都&CustomerCompanyName=決済会社&CustomerDepartmentName=決済部門&CustomerTel1=09011111111&CustomerTel2=09022222222&CustomerEmail1=sample@test.com&CustomerEmail2=sample@test.com
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID対象取引のオーダーIDを返却します。 |
||
---|---|---|---|---|
Status | status | 半角英字11桁
現状態 対象取引の取引状態を返却します。 |
{
"orderID": "ORDER0000001",
"status": "SHIPPED"
}
OrderID=ORDER0000001&Status=SHIPPED
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
PostpayReduction 請求減額
一部返品時等、請求金額を減額したい場合に請求金額の減額を行います。
リクエスト
ShopID | 必須 半角英数13桁
ショップID
|
|||
---|---|---|---|---|
ShopPass | 必須 半角英数64桁
ショップパスワード
|
|||
AccessID | 必須 半角英数32桁 固定
取引ID
|
|||
AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
Amount | 必須 半角数字6桁
利用金額 税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|||
Tax | 半角数字6桁
税送料 税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|||
DetailName | 全半角300桁
明細項目_明細名 単一明細の場合に設定してください。 (※1) |
|||
DetailPrice | 半角数字6桁
明細項目_単価 単一明細の場合に設定してください。(※1) |
|||
DetailQuantity | 半角数字5桁
明細項目_数量 単一明細の場合に設定してください。 (※1) |
|||
DetailBrand | 全半角300桁
明細項目_ブランド 単一明細の場合に設定してください。 (※1) |
|||
DetailCategory | 全半角300桁
明細項目_カテゴリ 単一明細の場合に設定してください。 (※1) |
|||
MultiItem |
明細情報一覧(※2)複数明細の場合に設定してください。 |
※1:単一明細のみ表示する場合、設定します。
複数明細を表示する場合、 明細情報一覧は設定しないでください。
明細情報一覧を設定した場合、本パラメータは無視されます。
※2:複数明細を表示する場合、設定します。
以下のXMLフォーマットを整形(タブや改行の除去)し、
UTF-8でBase64エンコードした値を設定してください。
/payment/PostpayReduction.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=150&Tax=15&DetailName=商品名&DetailPrice=165&DetailQuantity=1&DetailBrand=減額ブランド&DetailCategory=減額カテゴリ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=150&Tax=15&MultiItem=PGRldGFpbHNJbmZvPiA8ZGV0YWlsPiA8bmFtZT5U44K344Oj44OEPC9uYW1lPiA8cHJpY2U+MTIwMDwvcHJpY2U+IDxxdWFudGl0eT4zPC9xdWFudGl0eT4gPGJyYW5kPuODhuOCueODiOODluODqeODs+ODiTwvYnJhbmQ+IDxjYXRlZ29yeT7jg6Hjg7Pjgrrjg5XjgqHjg4Pjgrfjg6fjg7M8L2NhdGVnb3J5PiA8L2RldGFpbD4gPGRldGFpbD4gPG5hbWU+44K444Oj44Kx44OD44OIPC9uYW1lPiA8cHJpY2U+MjUwMDA8L3ByaWNlPiA8cXVhbnRpdHk+MTwvcXVhbnRpdHk+IDwvZGV0YWlsPiA8L2RldGFpbHNJbmZvPg==PGRldGFpbHNJbmZvPiA8ZGV0YWlsPiA8bmFtZT5U44K344Oj44OEPC9uYW1lPiA8cHJpY2U+MTIwMDwvcHJpY2U+IDxxdWFudGl0eT4zPC9xdWFudGl0eT4gPGJyYW5kPuODhuOCueODiOODluODqeODs+ODiTwvYnJhbmQ+IDxjYXRlZ29yeT7jg6Hjg7Pjgrrjg5XjgqHjg4Pjgrfjg6fjg7M8L2NhdGVnb3J5PiA8L2RldGFpbD4gPGRldGFpbD4gPG5hbWU+44K444Oj44Kx44OD44OIPC9uYW1lPiA8cHJpY2U+MjUwMDA8L3ByaWNlPiA8cXVhbnRpdHk+MTwvcXVhbnRpdHk+IDwvZGV0YWlsPiA8L2RldGFpbHNJbmZvPg==
[XMLフォーマット]
detailsInfo |
明細情報属性 |
||
---|---|---|---|
detail |
明細情報最大15件まで指定できます。 |
||
name | 必須 全半角300桁
明細名 |
||
price | 必須 半角数字6桁
単価半角数字で税込みの単価を設定してください。 |
||
quantity | 必須 半角数字5桁
数量半角数字(マイナス許可)で設定してください。 |
||
brand | 全半角300桁
ブランド |
||
category | 全半角300桁
カテゴリ |
XMLヘッダは不要です。
[XMLサンプル]
<detailsInfo>
<detail>
<name>Tシャツ</name>
<price>1200</price>
<quantity>3</quantity>
<brand>テストブランド</brand>
<category>メンズファッション</category>
</detail>
<detail>
<name>ジャケット</name>
<price>25000</price>
<quantity>1</quantity>
</detail>
</detailsInfo>
リクエスト
shopID |
必須
半角英数13桁
ショップID |
|
---|---|---|
shopPass |
必須
半角英数64桁
ショップパスワード |
|
accessID |
必須
半角英数32桁 固定
取引ID【取引登録】で発行された値を設定します。 |
|
accessPass |
必須
半角英数32桁 固定
取引パスワード【取引登録】で発行された値を設定します。 |
|
orderID |
必須
半角英数記号27桁
オーダーID【取引登録】で指定した値を設定します。 |
|
amount |
半角数字6桁
利用金額税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|
tax |
半角数字6桁
税送料税送料を指定した場合は、利用金額 + 税送料が決済金額となります。 |
|
details | 必須
明細一覧最大15件まで指定できます。 |
|
name | 必須 全半角300桁
明細項目_明細名【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
price | 必須 半角数字6桁
明細項目_単価【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
quantity | 必須 半角数字5桁
明細項目_数量【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
brand | 全半角300桁
明細項目_ブランド【明細項目_単価】半角数字で税込みの単価を設定してください。 |
|
category | 全半角300桁
明細項目_カテゴリ【明細項目_単価】半角数字で税込みの単価を設定してください。 |
/payment/PostpayReduction.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"accessID":"a6a6b0061347e90cdef806b39bd28705",
"accessPass":"5e0e54b892e14ed03e8cf807a6053813",
"orderID":"ORDER0000001",
"amount":"1000",
"details":[
{
"name":"Tシャツ",
"price":"100",
"quantity":"5",
"brand":"後払い",
"category":"服"
},
{
"name":"パンツ",
"price":"500",
"quantity":"1"
}
]
}
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
Status | status | 半角英字11桁
現状態 対象取引の取引状態を返却します。 |
||
Amount | amount | 半角数字6桁
利用金額
|
||
Tax | tax | 半角数字6桁
税送料
|
||
PostpayTransactionId | postpayTransactionId | 半角英数11桁
後払い取引ID後払い側の取引IDを返却します。 |
||
CheckString | checkString | 半角英数64桁
改ざんチェック文字列OrderID、AccessID、ShopID、ShopPass、PostpayTransactionIdを連結し、SHA256ハッシュした値を返却します。 |
{
"orderID": "ORDER0000001",
"status": "SHIPPED",
"amount": "1000",
"tax": "-",
"postpayTransactionId": "22222222222",
"checkString": "046339df0f5b6c30ff0cc229f59d4b9b830da6c16748d263b4260a9295930ee0"
}
OrderID=ORDER0000001&Status=SHIPPED&Amount=1000&Tax=-&PostpayTransactionId=22222222222&CheckString=046339df0f5b6c30ff0cc229f59d4b9b830da6c16748d263b4260a9295930ee0
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001
SearchTradePostpay/SearchTradeMulti 取引状態参照
対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
PayType | 必須 半角数字2桁
決済方法44:後払い |
/payment/SearchTradePostpay.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"orderID": "ORDER0000001"
}
/payment/SearchTradePostpay.idPass
/payment/SearchTradeMulti.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=44
レスポンス
正常
Status | status |
現状態 UNPROCESSED:未決済 |
||
---|---|---|---|---|
ProcessDate | processDate | 半角数字14桁 固定
処理日時 処理を実施した日時を返却します。 |
||
AccessID | accessID | 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 半角英数32桁 固定
取引パスワード
|
||
Amount | amount | 半角数字6桁
利用金額
|
||
Tax | tax | 半角数字6桁
税送料
|
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
||
PayType | payType | 半角数字2桁
決済方法44:後払い |
||
PostpayCancelAmount | postpayCancelAmount | 半角数字6桁
キャンセル金額該当取引について発生したキャンセル・返金額を返却します。 |
||
PostpayCancelTax | postpayCancelTax | 半角数字6桁
キャンセル税送料金額該当取引について発生したキャンセル・返金税送料を返却します。 |
||
PostpayTransactionId | postpayTransactionId | 半角英数11桁
後払い取引ID 後払い側の取引IDです。 |
||
ForceCancelDate | forceCancelDate | 半角数字8桁 固定
強制キャンセル日付 強制キャンセル日付、または強制キャンセル予定日を返却します。 |
{
"status": "SHIPPED",
"processDate": "20201225173801",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"amount": "1000",
"tax": "-",
"clientField1": "",
"clientField2": "",
"clientField3": "",
"payType": "44",
"postpayCancelAmount": "0",
"postpayCancelTax": "0",
"postpayTransactionId": "11111111111",
"forceCancelDate": ""
}
Status=SHIPPED&ProcessDate=20201225173801&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=-&ClientField1=&ClientField2=&ClientField3=&PayType=44&PostpayCancelAmount=0&PostpayCancelTax=0&PostpayTransactionId=11111111111&ForceCancelDate=
{
"errCode":"E01",
"errInfo":"E01040001"
}
ErrCode=E01&ErrInfo=E01040001